home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / cmds / ditroff / RCS / ditroff.man,v < prev    next >
Encoding:
Text File  |  1990-07-11  |  7.5 KB  |  350 lines
  1. head     1.1;
  2. branch   ;
  3. access   ;
  4. symbols  ;
  5. locks    stolcke:1.1; strict;
  6. comment  @@;
  7.  
  8.  
  9. 1.1
  10. date     90.07.11.14.31.39;  author ouster;  state Exp;
  11. branches ;
  12. next     ;
  13.  
  14.  
  15. desc
  16. @@
  17.  
  18.  
  19.  
  20. 1.1
  21. log
  22. @Initial revision
  23. @
  24. text
  25. @.TH DITROFF 1 
  26. .UC 1
  27. .SH NAME
  28. ditroff \- text formatting and typesetting
  29. .SH SYNOPSIS
  30. .B ditroff
  31. [ option ] ...
  32. [ file ] ...
  33. .SH DESCRIPTION
  34. .I Ditroff
  35. formats text in the named
  36. .I files
  37. for printing on the printer selected.
  38. Different output devices may be selected with the
  39. environment variables TYPESETTER and PRINTER or
  40. with the \-P option.
  41. Output will be processed as specified in the
  42. .I ditcap
  43. file, for the particular printer selected.
  44. The companion preprocessors, pic, ideal, deqn,
  45. tbl and grn all accept the TYPESETTER and PRINTER environment
  46. variables,
  47. have the \-P option,
  48. and access the ditcap file.
  49. .BR 
  50. .IB Troff 's
  51. capabilities are described in the
  52. .I Nroff/Troff user's manual.
  53. .PP
  54. It is a good idea to specify a printer 
  55. using one of the environment variables (PRINTER or TYPESETTER),
  56. or by using the
  57. .BI \-P printer
  58. option for ditroff and each of its preprocessors.
  59. This is advisable since each preprocessor selects a different default
  60. device if none is specified.
  61. The device independent troff (troff_p) and its associated preprocessors
  62. (eqn, grn, tbl, ideal, pic,  ...)
  63. access the environment variables (TYPESETTER and PRINTER),
  64. support the 
  65. .BI \-P printer
  66. option,
  67. and access the
  68. .I ditcap 
  69. file when processing troff files.
  70. .PP
  71. If no
  72. .I file
  73. argument is present, the standard input is read.
  74. An argument consisting of a single minus
  75. .RB ( \- )
  76. is taken to be
  77. a file name corresponding to the standard input.
  78. The options are:
  79. .LP
  80. Troff options:
  81. .TP "\w'\f3\-m\f1name  'u"
  82. .BI \-P dev
  83. Prepare output for typesetter
  84. .IR dev .
  85. If no printer is specified, the default is the Laser Writer (lw).
  86. The environment variable PRINTER will override the default, and
  87. the environment variable TYPESETTER overrides PRINTER.
  88. A \-P option will override all else.
  89. The 
  90. .I ditcap
  91. file is searched for this printer,
  92. and the printer type and other options are set from this file.
  93. .TP
  94. .BI \-T typ
  95. Change the printer type to
  96. .I typ ,
  97. and don't read the printer type from the ditcap file.
  98. .TP
  99. .BI \-F dir
  100. Use font directory
  101. .I dir
  102. instead of /sprite/lib/ditroff.
  103. This overrides the (fd) characteristic if it is set in the
  104. .I ditcap
  105. file.
  106. .TP
  107. .BI \-D ent
  108. Use the ditcap entry for 
  109. .I ent ,
  110. rather than the ditcap entry for 
  111. .I dev .
  112. Thus the ditcap characteristics are read from the ditcap
  113. entry
  114. .I ent ,
  115. and the output is sent to 
  116. .I dev .
  117. .TP
  118. .B \-t
  119. Send the troff_p output to standard output.
  120. If the (ft) characteristic is set in the ditcap file,
  121. then pass the output through this filter before sending it to 
  122. standard output.
  123. .TP
  124. .B \-a
  125. Send a printable ASCII approximation
  126. of the results to the standard output.
  127. If the (fa) characteristic is set in the ditcap file,
  128. then pass the output through this filter before sending it to 
  129. standard output.
  130. .TP
  131. .BI \-o list
  132. Print only pages whose page numbers appear in the comma-separated \fIlist\fP
  133. of numbers and ranges.  A range
  134. .IB N \- M
  135. means pages \fIN\fP through
  136. .IR M ;
  137. an initial \fI\-N\fP means from the beginning to page
  138. .IR N ;
  139. and a final
  140. .IR N \-
  141. means from \fIN\fP to the end.
  142. .TP
  143. .BI \-n N
  144. Number first generated page
  145. .IR N .
  146. .TP
  147. .BI \-m name
  148. Prepend the macro file
  149. .BI /sprite/lib/ditroff/tmac. name
  150. to the input
  151. .IR files .
  152. .TP
  153. .BI \-r aN
  154. Set register \fIa\fP (one-character) to
  155. .IR N .
  156. .TP
  157. \fB\-i\fP
  158. Read standard input after the input files are exhausted.
  159. .TP
  160. \fB\-q\fP
  161. Disable echoing during a \fB.rd\fP request.
  162. .TP
  163. .BI \-debug
  164. Print the lines that ditroff would run,
  165. rather than making system calls.
  166. .LP
  167. Preprocessing options:
  168. .TP "\w'\f3\-m\f1name 'u"
  169. .BI \-tbl
  170. Pipe through tbl.
  171. .TP
  172. .BI \-eqn
  173. Pipe through eqn.
  174. .TP
  175. .BI \-seqn
  176. Pipe through eqn
  177. using the special characters (in /sprite/lib/ditroff/eqnxxxxx).
  178. .TP
  179. .BI \-grn
  180. Pipe through grn.
  181. .TP
  182. .BI \-pic
  183. Pipe through pic.
  184. .TP
  185. .BI \-refer
  186. Pipe through refer.
  187. .TP
  188. .BI \-ideal
  189. Pipe through ideal.
  190. .LP
  191. Spooling options:
  192. .TP "\w'\f3\-m\f1name 'u"
  193. .BI \-h 
  194. Don't print the burst page.
  195. .TP
  196. .BI \-m
  197. Send mail upon completion of the printing job.
  198. .TP
  199. .BI \-C name
  200. Set the classname on the burst page to
  201. .I name .
  202. .TP
  203. .BI \-J name
  204. Set the jobname on the burst page to
  205. .I name .
  206. .TP
  207. .BI \-# N
  208. Print 
  209. .I N
  210. copies of the job.
  211. .LP
  212. Some options of 
  213. .I troff 
  214. only apply if you have a C/A/T typesetter attached to your system.
  215. These options are here for historical reasons:
  216. .TP
  217. .BI \-s N
  218. Stop every \fIN\fP pages.  \fItroff\fP
  219. stops the phototypesetter every \fIN\fP pages, produces a trailer to allow
  220. changing cassettes, and resumes when the typesetter's start button is pressed.
  221. .TP
  222. \fB\-f\fP
  223. Refrain from feeding out paper and stopping
  224. phototypesetter at the end of the run.
  225. .TP
  226. \fB\-w\fP
  227. Wait until phototypesetter is available, if currently busy.
  228. .TP
  229. \fB\-b\fP
  230. Report whether the phototypesetter is busy or available.
  231. No text processing is done.
  232. .TP
  233. .BR \-p N
  234. Print all characters in point size\fI N\fP
  235. while retaining all prescribed spacings and motions,
  236. to reduce phototypesetter elapsed time.
  237. .SH PROCESSING
  238. .LP
  239. The following details are only important to the user who
  240. wants to set the environment variable DITCAP
  241. and change ditcap entries.
  242. .br
  243. The details of how files are processed is as follows:
  244. .br
  245. ( (xx) indicates ditcap characteristics and [ ] indicates
  246. optional parts )
  247. .LP
  248. First all files are run through the preprocessors specified.
  249. (we show all preprocessors, but only a few would be used together)
  250. The first
  251. processor receives all the files as input - note that this could be troff_p.
  252. This part of the command line is assembled as follows.
  253. .IP "  PRE = " 8
  254. refer SFILES | tbl | grn TYFT | \\
  255. .br
  256. pic TYFT | ideal TYFT | eqn TYFT |
  257. .IP " " 6
  258. Where SFILES = "[(se)] files"
  259. the (se) string being prepended 
  260. if the 
  261. .BI \-seqn
  262. option is selected and
  263. if the (se) characteristic is specified in 
  264. the ditcap file.
  265. .br
  266. And TYFT = " -T
  267. .I typ
  268. [-F
  269. .I dir
  270. ] "
  271. .I typ
  272. is either specified
  273. in the ditcap file (ty),
  274. or using the
  275. .BI \-T 
  276. option;
  277. .I dir
  278. is used if it is specified by the
  279. .IB \-F
  280. option or if the (fd) characteristic is specified in the ditcap file.
  281. .IP "NOTE:" 7
  282. The preprocessors above and troff_p below
  283. would be the default ones given in the ditcap(5) documentation,
  284. unless appropriate ditcap characteristic are specified in the ditcap file.
  285. .IP I 5
  286. Standard troff job directed to a printer (\-a , \-t options not set)
  287. .IP "     %" 8
  288. PRE  troff_p  TYFT  [(ol)] [troff options] \\
  289. .br
  290. [ | (f1) ] [ | (f2) ] [ | (f3) ] [ | (f4) ] \\
  291. .br
  292. | lpr -Pdev [spooling options] [(lo)]
  293. .IP II 5
  294. Using a previewer (as specified in the ditcap file)
  295. .IP "     %" 8
  296. PRE  troff_p  TYFT  [(op)] [troff options] \\
  297. .br
  298. [ | (fp) ] > /tmp/dit$$
  299. .IP "     %" 8
  300. (pv) /tmp/dit$$
  301. .IP "     %" 8
  302. /bin/rm -f /tmp/dit$$
  303. .IP III 5
  304. Using the -t option
  305. .IP "     %" 8
  306. PRE  troff_p TYFT  -t [(ot)] [troff options] \\
  307. .br
  308. [ | (ft) ] > standard output
  309. .IP IV 5
  310. Using the -a option
  311. .IP "     %" 8
  312. PRE  troff_p TYFT  -a [(oa)] [troff options] \\
  313. .br
  314. [ | (fa) ] > standard output
  315. .IP " " 5
  316. .SH FILES
  317. .ta \w'/sprite/lib/ditroff/tmac.*  'u
  318. .br
  319. /etc/ditcap        printer specific info
  320. .br
  321. /sprite/lib/ditroff/tmac.*    standard macro files
  322. .br
  323. /sprite/lib/ditroff/dev*    font width tables
  324. .SH BUGS
  325. .PP
  326. The
  327. .B \-F
  328. option is not very useful since the same directory
  329. must be available on the machine that drives the printer.
  330. .SH "SEE ALSO"
  331. ditcap(5)
  332. .br
  333. trchange(l) for a list of differences, in
  334. .IR ditroff ,
  335. to TROFF commands
  336. .br
  337. J. F. Ossanna,
  338. .I Nroff/Troff user's manual
  339. .br
  340. B. W. Kernighan,
  341. .I
  342. A TROFF Tutorial
  343. .br
  344. eqn(1), grn(1), ideal(1), pic(1), refer(1),
  345. .br
  346. tbl(1), dterm(1), lpr(1), font(1)
  347. .SH AUTHOR
  348. Greg Heinzinger
  349. @
  350.